API Documentation
FilmGrainEffect.h
1 // FilmGrainEffect.h
3 //
5 
6 namespace nkAstraeus
7 {
16  class FilmGrainEffect final : public Effect
17  {
18  public :
19 
29 
30  // Getters
34  virtual EFFECT_TYPE getType () const override ;
42  float getStrength () const ;
46  bool getRgbNoise () const ;
50  bool getBlendGrainInTarget () const ;
51 
52  // Setters
71  void setStrength (float value) ;
82  void setRgbNoise (bool value) ;
94  void setBlendGrainInTarget (bool value) ;
95 
96  // Load
100  virtual bool load () override ;
104  virtual void unload () override ;
105  } ;
106 }
nkAstraeus::FilmGrainEffect::setSourceTexture
void setSourceTexture(nkGraphics::Texture *value)
nkAstraeus::FilmGrainEffect::getRgbNoise
bool getRgbNoise() const
nkAstraeus::FilmGrainEffect::getStrength
float getStrength() const
nkAstraeus::FilmGrainEffect::getType
virtual EFFECT_TYPE getType() const override
nkGraphics::Texture
A texture used for rendering, hosted on GPU.
Definition: Texture.h:35
nkAstraeus::EFFECT_TYPE
EFFECT_TYPE
Lists all effects supported.
Definition: EffectType.h:12
nkAstraeus::FilmGrainEffect::getBlendGrainInTarget
bool getBlendGrainInTarget() const
nkAstraeus::FilmGrainEffect::setStrength
void setStrength(float value)
nkAstraeus::FilmGrainEffect::setBlendGrainInTarget
void setBlendGrainInTarget(bool value)
nkAstraeus::FilmGrainEffect
A film grain effect.
Definition: FilmGrainEffect.h:17
nkAstraeus::FilmGrainEffect::getSourceTexture
nkGraphics::Texture * getSourceTexture() const
nkAstraeus
Encompasses all API of component NilkinsAstraeus.
Definition: Engine.h:7
nkAstraeus::Effect
Base class for all effects in the component.
Definition: Effect.h:16
nkAstraeus::FilmGrainEffect::setRgbNoise
void setRgbNoise(bool value)
nkAstraeus::FilmGrainEffect::load
virtual bool load() override
nkAstraeus::FilmGrainEffect::unload
virtual void unload() override
nkAstraeus::FilmGrainEffect::FilmGrainEffect
FilmGrainEffect()
nkAstraeus::FilmGrainEffect::~FilmGrainEffect
~FilmGrainEffect()